feat(bootstrap): save connected peers as backup bootstrap peers #8856

schomatis · 2022-04-07T20:27:46Z

This PR aims to close #3926.

Every 1 hour (DefaultBootstrapConfig.BackupBootstrapInterval, can override via Internal.BackupBootstrapInterval) we save a number of peers we're connected to in Kubo's datastore. If we can't connect to our "official" bootstrap peers defined in the Bootstrap config (if we don't hit the target in DefaultBootstrapConfig.MinPeerThreshold, again hardcoded, why is this not in the config file?) we resort to connecting to some of the peers from the above list.

How To Manually Test

export IPFS_LOGGING="bootstrap=debug"
ipfs daemon

Running a few seconds we'll see the log:

DEBUG	bootstrap	bootstrap/bootstrap.go:210	saved 8 connected peers (of 8 target) as bootstrap backup in the config

Stop the daemon.

Backup and remove the official bootstrap peers, CAREFUL:

ipfs config --json Bootstrap | tee bootstrap-peers.back
# List of hardcoded bootstrap peers, like: "/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN"

ipfs config --json Bootstrap []

At this point, the version in master should not be able to connect to the network:

ipfs daemon
# WARN	bootstrap	bootstrap/bootstrap.go:103	no bootstrap nodes configured: go-ipfs may have difficulty connecting to the network

ipfs swarm peers
# nothing

With this PR:

ipfs daemon
# DEBUG	bootstrap	bootstrap/bootstrap.go:242	not enough bootstrap peers to fill the remaining target of 4 connections, trying backup list

ipfs swarm peers
# normal amount of peers, connected to the network

Restore bootstrap with

ipfs config --json Bootstrap "$(cat bootstrap-peers.back)"

config/config.go

guseggert · 2022-04-22T20:09:31Z

@schomatis: let's put this in the repo datastore for now, so that we are free to change/remove it later without breaking folks.

schomatis · 2022-05-05T14:32:43Z

@guseggert Moved to datastore. Ready for review. Will need help with tests if required to land this.

BigLep · 2022-06-01T16:30:49Z

@guseggert : this is a mental note that I'd like to flag this one for code review Friday so we get it over the line.

Winterhuman · 2022-10-05T12:29:28Z

@BigLep Any update on this? I've read into the issue and it seems the end goal is to move this functionality into go-libp2p (libp2p/go-libp2p-kad-dht#254), is this still the plan?

guillaumemichel · 2023-02-06T10:56:36Z

This feature would be great to have. It enables:

less load on bootstrap nodes
faster bootstrap (finding self from the known closest peer still online)
more balanced RT buckets. Currently empty buckets are filled by querying a random key belonging to this bucket. Hence all the peers inside this bucket will all be very close from this random key, and will not be distributed uniformly in the bucket keyspace, which is desired as it reduces the number of hop during the lookup process.
less dependence on central bootstrap nodes, more dependence on known peers. Makes the network more decentralized

BigLep · 2023-02-16T01:47:17Z

Thanks for the flags. This has gotten lost amongst all the other priorities that have emerged so far in 2023. I have in the list for 0.20. A key thing we're missing is what is remaining to land this.

hacdias · 2023-05-16T14:10:18Z

I just rebased this and I will try taking a look at it during this week or the next week. This would be a great addition.

@Jorropo it would be great if you could take a look since you've reviewed it before.

hacdias

I went over the code, cleaned up some comments and pushed a fix. Also updated the main PR description with how to test manually. The code looks good to me and works well for me. What I think is left to review:

Decide if new variable names are fine, as well as defaults. I have no problems with them.
I would like to test this, but I don't see how we'd do it.

cc @ipfs/kubo-maintainers

lidel

Some nits below, but it does not have to be perfect, anything here is better than nothing.
Important part here is to have regression tests that ensure backup bootstrappers are used.

@hacdias I think testing would live in https://github.com/ipfs/kubo/tree/master/test/cli and be similar to swarm_test.go or dht_legacy_test.go:

configure node to have ipfs config --json Bootstrap [] and Discovery.MDNS.Enabled: false (we want it to boot and have no peers)
set bootstrap backup interval to to something small, like 250ms (could be config proposed below inline, or could be env override via os.LookupEnv)
start the daemon, confirm it has no peers (expected)
start the second peer (with default config and Discovery.MDNS.Enabled: false, we want it to be a member of public swarm, but not connect to the first one) and confirm it has some peers
manually connect first one to the second one
confirm the first one learned about other peers (ipfs swarm peers longer than 1)
shut down both daemons, and then start first one again
it should be connected to something thanks to the backed up peers (ipfs swarm peers longer than 1)

(to make this test work offline we could introduce a third node )

core/bootstrap/bootstrap.go

hacdias · 2023-05-17T12:22:37Z

@lidel I added a test that runs completely separately from the rest of the network. I made a slight change compared to what you suggested. We have 0, 1 and 2. They all have the same config (no bootstrap nodes, no MDNS enabled, 250ms for backup bootstrap interval). The following happens:

Start all daemons.
0 and 1 connect to each other. Wait for 0 to save 1 as backup bootstrap.
Ensure 0 and 1 are connected to 1 peer (each other). 2 is connected to none.
Stop all daemons.
Start 1 and 2. Connect both and ensure they're not connected.
Connect 1 and 2 and ensure they are connected.
Start 0. Ensure it connects automatically to 1 and discovers 2 via 1. They're all connected.

hacdias

I'm approving this. I will wait for one more approval since I wrote the test 😃

randomizeList

lidel · 2023-05-25T12:37:15Z

core/bootstrap/bootstrap.go

+	MinPeerThreshold:        4,
+	Period:                  30 * time.Second,
+	ConnectionTimeout:       (30 * time.Second) / 3, // Perod / 3
+	BackupBootstrapInterval: 1 * time.Hour,
+	MaxBackupBootstrapSize:  20,


ℹ️ We can expose these later under Internal.* if needed (in future PRs).

For now, only Internal.BackupBootstrapInterval is exposed for use in the test/cli/backup_bootstrap_test.go test. Not documenting it, as we may change the name/location later.

lidel

I think this one baked for long enough -- does the basic thing, we can refine in follow-up PRs, but is already way better than nothing.

Thank you all for pushing on this. Added changelog entry, merging when CI passes.

BigLep · 2023-05-25T14:53:18Z

@lidel : Awesome! I wanted to confirm that the default bootstrap peers will still stay in the list, but not now the list is augmented with additional peers based on past discovery.

The reason I'm asking is because of probelab's measurements that try and ascertain the DHT network node size based on the number of peerids that connect to it.

hacdias · 2023-05-25T15:17:25Z

@BigLep the default bootstrap peers stays. We add additional backup peers based on our connections. Those will be dialed if the default bootstrap list does not work.

schomatis linked an issue Apr 7, 2022 that may be closed by this pull request

Saving previously seen nodes for later bootstrapping #3926

Closed

schomatis requested a review from lidel April 7, 2022 20:28

schomatis self-assigned this Apr 7, 2022

schomatis mentioned this pull request Apr 7, 2022

Saving previously seen nodes for later bootstrapping #3926

Closed

guseggert reviewed Apr 7, 2022

View reviewed changes

config/config.go Outdated Show resolved Hide resolved

BigLep added this to the Best Effort Track milestone Apr 22, 2022

This comment was marked as resolved.

Sign in to view

schomatis force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from b4ad48f to efb9fe4 Compare May 5, 2022 14:31

schomatis requested a review from guseggert May 5, 2022 14:31

schomatis force-pushed the schomatis/feat/bootstrap/save-connected-peers branch 2 times, most recently from 4919894 to f2642f0 Compare May 5, 2022 14:36

lidel mentioned this pull request May 23, 2022

Document how to leverage /dnsaddr for peer/content/routing ipfs/in-web-browsers#193

Open

Winterhuman mentioned this pull request Oct 5, 2022

Persist peers for bootstrapping libp2p/rust-libp2p#2987

Closed

lidel mentioned this pull request Feb 2, 2023

IPFS is filtered in China and a growing list of other countries ipfs/notes#457

Open

hacdias requested review from hacdias and removed request for guseggert May 16, 2023 13:50

hacdias self-assigned this May 16, 2023

hacdias force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from f2642f0 to 94b3b8d Compare May 16, 2023 14:09

hacdias requested a review from a team as a code owner May 16, 2023 14:09

hacdias requested a review from Jorropo May 16, 2023 14:14

hacdias changed the title ~~feat(bootstrap): save connected peers as backup temporary bootstrap ones~~ feat(bootstrap): save connected peers as backup bootstrap peers May 17, 2023

hacdias reviewed May 17, 2023

View reviewed changes

hacdias force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from 8d4f6b3 to 5cd0c4d Compare May 17, 2023 09:42

lidel requested changes May 17, 2023

View reviewed changes

core/bootstrap/bootstrap.go Outdated Show resolved Hide resolved

core/bootstrap/bootstrap.go Outdated Show resolved Hide resolved

core/bootstrap/bootstrap.go Outdated Show resolved Hide resolved

hacdias force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from a64a86a to 416c6b6 Compare May 17, 2023 12:18

hacdias requested a review from lidel May 17, 2023 12:24

hacdias approved these changes May 17, 2023

View reviewed changes

schomatis and others added 3 commits May 24, 2023 15:07

feat(bootstrap): save connected peers as backup temporary bootstrap ones

ffa82f8

fix: do not add duplicated oldSavedPeers, not using tags, reuse

1c7f5d6

randomizeList

test: add regression test

93aa0f8

hacdias force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from 416c6b6 to 93aa0f8 Compare May 24, 2023 13:07

lidel assigned lidel and unassigned schomatis May 25, 2023

lidel force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from bbed7d9 to 1f4cbd6 Compare May 25, 2023 12:29

chore: add changelog

7339162

lidel force-pushed the schomatis/feat/bootstrap/save-connected-peers branch from 1f4cbd6 to 7339162 Compare May 25, 2023 12:30

lidel reviewed May 25, 2023

View reviewed changes

lidel approved these changes May 25, 2023

View reviewed changes

lidel merged commit 63561f3 into master May 25, 2023

lidel deleted the schomatis/feat/bootstrap/save-connected-peers branch May 25, 2023 12:39

Jorropo mentioned this pull request Jul 27, 2023

Censorship resistant bootstrapping (e.g. for wikipedia) #3908

Open

hacdias mentioned this pull request Dec 11, 2023

Make default bootstrappers used by IPFS/libp2p be a more robust list. ipfs/ipfs#478

Open

Jorropo mentioned this pull request Dec 28, 2023

如何搭建dht服务器，没有找到相关的代码，请问有没有热心大佬给个地址或者方法 libp2p/go-libp2p#2676

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(bootstrap): save connected peers as backup bootstrap peers #8856

feat(bootstrap): save connected peers as backup bootstrap peers #8856

schomatis commented Apr 7, 2022 •

edited by lidel

Loading

This comment was marked as resolved.

guseggert commented Apr 22, 2022

schomatis commented May 5, 2022

BigLep commented Jun 1, 2022

Winterhuman commented Oct 5, 2022 •

edited

Loading

guillaumemichel commented Feb 6, 2023

BigLep commented Feb 16, 2023 •

edited

Loading

hacdias commented May 16, 2023

hacdias left a comment •

edited

Loading

lidel left a comment

hacdias commented May 17, 2023

hacdias left a comment

lidel May 25, 2023 •

edited

Loading

lidel left a comment

BigLep commented May 25, 2023

hacdias commented May 25, 2023

feat(bootstrap): save connected peers as backup bootstrap peers #8856

feat(bootstrap): save connected peers as backup bootstrap peers #8856

Conversation

schomatis commented Apr 7, 2022 • edited by lidel Loading

How To Manually Test

This comment was marked as resolved.

guseggert commented Apr 22, 2022

schomatis commented May 5, 2022

BigLep commented Jun 1, 2022

Winterhuman commented Oct 5, 2022 • edited Loading

guillaumemichel commented Feb 6, 2023

BigLep commented Feb 16, 2023 • edited Loading

hacdias commented May 16, 2023

hacdias left a comment • edited Loading

Choose a reason for hiding this comment

lidel left a comment

Choose a reason for hiding this comment

hacdias commented May 17, 2023

hacdias left a comment

Choose a reason for hiding this comment

lidel May 25, 2023 • edited Loading

Choose a reason for hiding this comment

lidel left a comment

Choose a reason for hiding this comment

BigLep commented May 25, 2023

hacdias commented May 25, 2023

schomatis commented Apr 7, 2022 •

edited by lidel

Loading

Winterhuman commented Oct 5, 2022 •

edited

Loading

BigLep commented Feb 16, 2023 •

edited

Loading

hacdias left a comment •

edited

Loading

lidel May 25, 2023 •

edited

Loading